编写REST API 您所在的位置:网站首页 restful api接口规范form 编写REST API

编写REST API

2024-07-13 23:39| 来源: 网络整理| 查看: 265

REST API规范

编写REST API,实际上就是编写处理HTTP请求的async函数,不过,REST请求和普通的HTTP请求有几个特殊的地方:

REST请求仍然是标准的HTTP请求,但是,除了GET请求外,POST、PUT等请求的body是JSON数据格式,请求的Content-Type为application/json; REST响应返回的结果是JSON数据格式,因此,响应的Content-Type也是application/json。

REST规范定义了资源的通用访问格式,虽然它不是一个强制要求,但遵守该规范可以让人易于理解。

例如,商品Product就是一种资源。获取所有Product的URL如下:

GET /api/products

而获取某个指定的Product,例如,id为123的Product,其URL如下:

GET /api/products/123

新建一个Product使用POST请求,JSON数据包含在body中,URL如下:

POST /api/products

更新一个Product使用PUT请求,例如,更新id为123的Product,其URL如下:

PUT /api/products/123

删除一个Product使用DELETE请求,例如,删除id为123的Product,其URL如下:

DELETE /api/products/123

资源还可以按层次组织。例如,获取某个Product的所有评论,使用:

GET /api/products/123/reviews

当我们只需要获取部分数据时,可通过参数限制返回的结果集,例如,返回第2页评论,每页10项,按时间排序:

GET /api/products/123/reviews?page=2&size=10&sort=time koa处理REST

既然我们已经使用koa作为Web框架处理HTTP请求,因此,我们仍然可以在koa中响应并处理REST请求。

我们先创建一个rest-hello的工程,结构如下:

rest-hello/ | +- .vscode/ | | | +- launch.json


【本文地址】

公司简介

联系我们

今日新闻

    推荐新闻

    专题文章
      CopyRight 2018-2019 实验室设备网 版权所有